<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Global</title>
    
    <script src="scripts/prettify/prettify.js"> </script>
    <script src="scripts/prettify/lang-css.js"> </script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>

<body>

<div id="main">
    
    <h1 class="page-title">Global</h1>
    
    



<section>
    
<header>
    <h2>
    
    </h2>
    
</header>  

<article>
    <div class="container-overview">
    
    
    
        
        
        
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>

        
        
    
    </div>
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        <h3 class="subsection-title">Type Definitions</h3>
        
        <dl>
                
<dt>
    <h4 class="name" id="Address">Address</h4>
    
    
</dt>
<dd>
    
    
    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">Object</span>


            </li>
        </ul>
    

    
<dl class="details">
    
        
        <h5 class="subsection-title">Properties:</h5>
        
        <dl>

<table class="props">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		
		
		
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr>
            
                <td class="name"><code>ipaddress</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>
            
            
            
            
            
            <td class="description last">The IP address</td>
        </tr>
	
	
	
        <tr>
            
                <td class="name"><code>port</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>
            
            
            
            
            
            <td class="description last">The port for this address</td>
        </tr>
	
	
	</tbody>
</table></dl>
        
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="net.js.html">vertx/net.js</a>, <a href="net.js.html#line355">line 355</a>
    </li></ul></dd>
    
    
    
    
    
    
    
</dl>

    
    
</dd>

            
                
<dt>
    <h4 class="name" id="BodyHandler"><span class="type-signature"></span>BodyHandler<span class="signature">(buffer)</span><span class="type-signature"></span></h4>
    
    
</dt>
<dd>
    
    
    <div class="description">
        A <code>BodyHandler</code> is a <a href="global.html#Handler"><code>Handler</code></a> that accepts a
<a href="buffer-Buffer.html"><code>Buffer</code></a> as it's parameter.
    </div>
    

    
    
    
    
    
        <h5>Parameters:</h5>
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		
		
		
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr>
            
                <td class="name"><code>buffer</code></td>
            
            
            <td class="type">
            
                
<span class="param-type"><a href="buffer-Buffer.html">module:vertx/buffer~Buffer</a></span>


            
            </td>
            
            
            
            
            
            <td class="description last">A Buffer object containing the body of the message</td>
        </tr>
	
	
	</tbody>
</table>
    
    
    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="http.js.html">vertx/http.js</a>, <a href="http.js.html#line36">line 36</a>
    </li></ul></dd>
    
    
    
    
    
    
    
</dl>

    
    

    

    
    
    
    
    
    
    
</dd>

            
                
<dt>
    <h4 class="name" id="ConnectHandler"><span class="type-signature"></span>ConnectHandler<span class="signature">(netSocket)</span><span class="type-signature"></span></h4>
    
    
</dt>
<dd>
    
    
    <div class="description">
        A <code>ConnectHandler</code> is a <a href="global.html#Handler"><code>Handler</code></a> that accepts a
<a href="net.NetSocket.html"><code>module:vertx/net.NetSocket</code></a> as it's parameter.
    </div>
    

    
    
    
    
    
        <h5>Parameters:</h5>
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		
		
		
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr>
            
                <td class="name"><code>netSocket</code></td>
            
            
            <td class="type">
            
                
<span class="param-type"><a href="net.NetSocket.html">module:vertx/net.NetSocket</a></span>


            
            </td>
            
            
            
            
            
            <td class="description last">The raw socket</td>
        </tr>
	
	
	</tbody>
</table>
    
    
    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="net.js.html">vertx/net.js</a>, <a href="net.js.html#line50">line 50</a>
    </li></ul></dd>
    
    
    
    
    
    
    
</dl>

    
    

    

    
    
    
    
    
    
    
</dd>

            
                
<dt>
    <h4 class="name" id="DeploymentId">DeploymentId</h4>
    
    
</dt>
<dd>
    
    <div class="description">
        A DeploymentId is used to identify a specific verticle deployment.
    </div>
    
    
    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">string</span>


            </li>
        </ul>
    

    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="container.js.html">vertx/container.js</a>, <a href="container.js.html#line21">line 21</a>
    </li></ul></dd>
    
    
    
    
    
    <dt class="tag-see">See:</dt>
    <dd class="tag-see">
        <ul>
            <li><a href="container.html">module:vertx/container</a></li>
        </ul>
    </dd>
    
    
    
</dl>

    
    
</dd>

            
                
<dt>
    <h4 class="name" id="FileProps">FileProps</h4>
    
    
</dt>
<dd>
    
    
    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">Object</span>


            </li>
        </ul>
    

    
<dl class="details">
    
        
        <h5 class="subsection-title">Properties:</h5>
        
        <dl>

<table class="props">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		
		
		
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr>
            
                <td class="name"><code>creationTime</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">date</span>


            
            </td>
            
            
            
            
            
            <td class="description last">The date the file was created</td>
        </tr>
	
	
	
        <tr>
            
                <td class="name"><code>lastAccessTime</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">date</span>


            
            </td>
            
            
            
            
            
            <td class="description last">The date the file was last accessed</td>
        </tr>
	
	
	
        <tr>
            
                <td class="name"><code>lastModifiedTime</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">date</span>


            
            </td>
            
            
            
            
            
            <td class="description last">The date the file was last modified</td>
        </tr>
	
	
	
        <tr>
            
                <td class="name"><code>isDirectory</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>
            
            
            
            
            
            <td class="description last">is the file a directory?</td>
        </tr>
	
	
	
        <tr>
            
                <td class="name"><code>isOther</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>
            
            
            
            
            
            <td class="description last">Is the file some other type? I.e. not a directory, regular file or symbolic link</td>
        </tr>
	
	
	
        <tr>
            
                <td class="name"><code>isRegularFile</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>
            
            
            
            
            
            <td class="description last">is the file a regular file?</td>
        </tr>
	
	
	
        <tr>
            
                <td class="name"><code>isSymbolicLink</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>
            
            
            
            
            
            <td class="description last">is the file a symlink?</td>
        </tr>
	
	
	
        <tr>
            
                <td class="name"><code>size</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>
            
            
            
            
            
            <td class="description last">the size of the file in bytes</td>
        </tr>
	
	
	</tbody>
</table></dl>
        
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="file_system.js.html">vertx/file_system.js</a>, <a href="file_system.js.html#line66">line 66</a>
    </li></ul></dd>
    
    
    
    
    
    
    
</dl>

    
    
</dd>

            
                
<dt>
    <h4 class="name" id="FileSystemProps">FileSystemProps</h4>
    
    
</dt>
<dd>
    
    
    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">Object</span>


            </li>
        </ul>
    

    
<dl class="details">
    
        
        <h5 class="subsection-title">Properties:</h5>
        
        <dl>

<table class="props">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		
		
		
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr>
            
                <td class="name"><code>totalSpace</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>
            
            
            
            
            
            <td class="description last">The total space on the file system, in bytes</td>
        </tr>
	
	
	
        <tr>
            
                <td class="name"><code>unallocatedSpace</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>
            
            
            
            
            
            <td class="description last">The total unallocated space on the file syste, in bytes</td>
        </tr>
	
	
	
        <tr>
            
                <td class="name"><code>usableSpace</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>
            
            
            
            
            
            <td class="description last">The total usable space on the file system, in bytes</td>
        </tr>
	
	
	</tbody>
</table></dl>
        
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="file_system.js.html">vertx/file_system.js</a>, <a href="file_system.js.html#line818">line 818</a>
    </li></ul></dd>
    
    
    
    
    
    
    
</dl>

    
    
</dd>

            
                
<dt>
    <h4 class="name" id="Flag">Flag</h4>
    
    
</dt>
<dd>
    
    <div class="description">
        Flags used when opening files working with the vert.x 
<a href="file_system.html"><code>FileSystem</code></a>
    </div>
    
    
    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>


            </li>
        </ul>
    

    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="file_system.js.html">vertx/file_system.js</a>, <a href="file_system.js.html#line564">line 564</a>
    </li></ul></dd>
    
    
    
    
    
    
    
</dl>

    
    
</dd>

            
                
<dt>
    <h4 class="name" id="Handler"><span class="type-signature"></span>Handler<span class="signature">()</span><span class="type-signature"></span></h4>
    
    
</dt>
<dd>
    
    
    <div class="description">
        Vert.x makes heavy use of callback handlers in the API. A basic handler is
simply a function that is called when vert.x events are fired, and expects
no parameters.
    </div>
    

    
    
    
    
    
    
    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="vertx.js.html">vertx.js</a>, <a href="vertx.js.html#line141">line 141</a>
    </li></ul></dd>
    
    
    
    
    
    <dt class="tag-see">See:</dt>
    <dd class="tag-see">
        <ul>
            <li><a href="module-vertx.html#runOnContext">module:vertx.runOnContext</a></li>
        </ul>
    </dd>
    
    
    
</dl>

    
    

    

    
    
    
    
    
    
    
</dd>

            
                
<dt>
    <h4 class="name" id="JsonMessage">JsonMessage</h4>
    
    
</dt>
<dd>
    
    <div class="description">
        Message handlers receive event_bus messages as JSON.
    </div>
    
    
    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">JSON</span>


            </li>
        </ul>
    

    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="event_bus.js.html">vertx/event_bus.js</a>, <a href="event_bus.js.html#line22">line 22</a>
    </li></ul></dd>
    
    
    
    
    
    <dt class="tag-see">See:</dt>
    <dd class="tag-see">
        <ul>
            <li><a href="event_bus.html">module:vertx/event_bus</a></li>
        </ul>
    </dd>
    
    
    
</dl>

    
    
</dd>

            
                
<dt>
    <h4 class="name" id="Message">Message</h4>
    
    
</dt>
<dd>
    
    <div class="description">
        While JSON is the preferred messaging on the event bus,
you can send any basic type as a message, for example,
<code>string</code>, <code>boolean</code>, etc. can all be passed
directly into <a href="event_bus.html#send"><code>module:vertx/event_bus.send</code></a>. You may also
send <a href="buffer-Buffer.html"><code>module:vertx/buffer~Buffer</code></a>s and plain old 
Javascript objects. Objects will be converted to <code>JSON</code>
before being placed on the bus.
    </div>
    
    
    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">string</span>
|

<span class="param-type">boolean</span>
|

<span class="param-type">number</span>
|

<span class="param-type">Object</span>
|

<span class="param-type"><a href="buffer-Buffer.html">module:vertx/buffer~Buffer</a></span>


            </li>
        </ul>
    

    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="event_bus.js.html">vertx/event_bus.js</a>, <a href="event_bus.js.html#line24">line 24</a>
    </li></ul></dd>
    
    
    
    
    
    <dt class="tag-see">See:</dt>
    <dd class="tag-see">
        <ul>
            <li><a href="event_bus.html">module:vertx/event_bus</a></li>
        </ul>
    </dd>
    
    
    
</dl>

    
    
</dd>

            
                
<dt>
    <h4 class="name" id="MessageHandler"><span class="type-signature"></span>MessageHandler<span class="signature">(message)</span><span class="type-signature"></span></h4>
    
    
</dt>
<dd>
    
    
    <div class="description">
        A <code>MessageHandler</code> is a <a href="global.html#Handler"><code>Handler</code></a> that responds to
messages on the <a href="event_bus.html"><code>module:vertx/event_bus</code></a> module. <code>MessageHandler</code>s
are called with a <a href="global.html#JsonMessage"><code>JsonMessage</code></a> object as the parameter.
    </div>
    

    
    
    
    
    
        <h5>Parameters:</h5>
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		
		
		
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr>
            
                <td class="name"><code>message</code></td>
            
            
            <td class="type">
            
                
<span class="param-type"><a href="global.html#JsonMessage">JsonMessage</a></span>


            
            </td>
            
            
            
            
            
            <td class="description last">The JSON message</td>
        </tr>
	
	
	</tbody>
</table>
    
    
    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="event_bus.js.html">vertx/event_bus.js</a>, <a href="event_bus.js.html#line26">line 26</a>
    </li></ul></dd>
    
    
    
    
    
    <dt class="tag-see">See:</dt>
    <dd class="tag-see">
        <ul>
            <li><a href="event_bus.html#registerHandler">module:vertx/event_bus.registerHandler</a></li>
        </ul>
    </dd>
    
    
    
</dl>

    
    

    

    
    
    
    
    
    
    
</dd>

            
                
<dt>
    <h4 class="name" id="RequestHandler"><span class="type-signature"></span>RequestHandler<span class="signature">(request)</span><span class="type-signature"></span></h4>
    
    
</dt>
<dd>
    
    
    <div class="description">
        A <code>RequestHandler</code> is a <a href="global.html#Handler"><code>Handler</code></a> that responds to
notifications from objects in the <code>vertx/http</code> module and expects
an <a href="http.HttpServerRequest.html"><code>HttpServerRequest</code></a> object
as its parameter.
    </div>
    

    
    
    
    
    
        <h5>Parameters:</h5>
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		
		
		
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr>
            
                <td class="name"><code>request</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">message</span>


            
            </td>
            
            
            
            
            
            <td class="description last">The incoming message</td>
        </tr>
	
	
	</tbody>
</table>
    
    
    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="http.js.html">vertx/http.js</a>, <a href="http.js.html#line1711">line 1711</a>
    </li></ul></dd>
    
    
    
    
    
    <dt class="tag-see">See:</dt>
    <dd class="tag-see">
        <ul>
            <li><a href="http.HttpServer.html#requestHandler">module:vertx/http.HttpServer#requestHandler</a></li>
        </ul>
    </dd>
    
    
    
</dl>

    
    

    

    
    
    
    
    
    
    
        <h5>Example</h5>
        
    <pre class="prettyprint"><code>var http = require('vertx/http');
var server = http.createHttpServer();

server.requestHandler( function( request ) {
  // This function is executed for each
  // request event on our server
} );</code></pre>

    
</dd>

            
                
<dt>
    <h4 class="name" id="ResponseHandler"><span class="type-signature"></span>ResponseHandler<span class="signature">(response)</span><span class="type-signature"></span></h4>
    
    
</dt>
<dd>
    
    
    <div class="description">
        A <code>ResponseHandler</code> is a <a href="global.html#Handler"><code>Handler</code></a> that accepts a
<a href="http.HttpClientResponse.html"><code>ClientResponse</code></a> 
object as it's parameter.
    </div>
    

    
    
    
    
    
        <h5>Parameters:</h5>
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		
		
		
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr>
            
                <td class="name"><code>response</code></td>
            
            
            <td class="type">
            
                
<span class="param-type"><a href="http.HttpClientResponse.html">module:vertx/http.HttpClientResponse</a></span>


            
            </td>
            
            
            
            
            
            <td class="description last">The HTTP client response</td>
        </tr>
	
	
	</tbody>
</table>
    
    
    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="http.js.html">vertx/http.js</a>, <a href="http.js.html#line1089">line 1089</a>
    </li></ul></dd>
    
    
    
    
    
    
    
</dl>

    
    

    

    
    
    
    
    
    
    
</dd>

            
                
<dt>
    <h4 class="name" id="ResultHandler"><span class="type-signature"></span>ResultHandler<span class="signature">(cause, result)</span><span class="type-signature"></span></h4>
    
    
</dt>
<dd>
    
    
    <div class="description">
        File system operations are handled asynchronously. The result of the operations
are given to a <code>ResultHandler</code>. The <code>ResultHandler</code> is 
just a <a href="global.html#Handler"><code>Handler</code></a> that accepts two parameters: 1) an exception object
if an error occurred; and 2) the result of the operation, the type of which is
determined by the firing event.
    </div>
    

    
    
    
    
    
        <h5>Parameters:</h5>
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		
		
		
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr>
            
                <td class="name"><code>cause</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">Exception</span>


            
            </td>
            
            
            
            
            
            <td class="description last">This will be <code>null</code> if the operation succeeded</td>
        </tr>
	
	
	
        <tr>
            
                <td class="name"><code>result</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>
            
            
            
            
            
            <td class="description last">The result of the operation event this handler cares about</td>
        </tr>
	
	
	</tbody>
</table>
    
    
    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="file_system.js.html">vertx/file_system.js</a>, <a href="file_system.js.html#line24">line 24</a>
    </li></ul></dd>
    
    
    
    
    
    
    
</dl>

    
    

    

    
    
    
    
    
    
    
</dd>

            
                
<dt>
    <h4 class="name" id="SockJSHandler"><span class="type-signature"></span>SockJSHandler<span class="signature">(sockJSSocket)</span><span class="type-signature"></span></h4>
    
    
</dt>
<dd>
    
    
    <div class="description">
        A <code>SockJSHandler</code> is a <a href="global.html#Handler"><code>Handler</code></a> that responds to
notifications from objects in the <code>vertx/http</code> module and expects
an <a href="http.HttpServerRequest.html"><code>HttpServerRequest</code></a> object
as its parameter.
    </div>
    

    
    
    
    
    
        <h5>Parameters:</h5>
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		
		
		
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr>
            
                <td class="name"><code>sockJSSocket</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">SockJSSocket</span>


            
            </td>
            
            
            
            
            
            <td class="description last">The socket object</td>
        </tr>
	
	
	</tbody>
</table>
    
    
    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="sockjs.js.html">vertx/sockjs.js</a>, <a href="sockjs.js.html#line136">line 136</a>
    </li></ul></dd>
    
    
    
    
    
    <dt class="tag-see">See:</dt>
    <dd class="tag-see">
        <ul>
            <li><a href="http.HttpServer.html#requestHandler">module:vertx/http.HttpServer#requestHandler</a></li>
        </ul>
    </dd>
    
    
    
</dl>

    
    

    

    
    
    
    
    
    
    
        <h5>Example</h5>
        
    <pre class="prettyprint"><code>var http = require('vertx/http');
var server = http.createHttpServer();

server.requestHandler( function( request ) {
  // This function is executed for each
  // request event on our server
} );</code></pre>

    
</dd>

            
                
<dt>
    <h4 class="name" id="TimerId">TimerId</h4>
    
    
</dt>
<dd>
    
    <div class="description">
        A TimerId is just a number that identifies a given timer.
    </div>
    
    
    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>


            </li>
        </ul>
    

    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="timer.js.html">vertx/timer.js</a>, <a href="timer.js.html#line21">line 21</a>
    </li></ul></dd>
    
    
    
    
    
    <dt class="tag-see">See:</dt>
    <dd class="tag-see">
        <ul>
            <li><a href="timer.html">module:vertx/timer</a></li>
        </ul>
    </dd>
    
    
    
</dl>

    
    
</dd>

            
                
<dt>
    <h4 class="name" id="UploadHandler"><span class="type-signature"></span>UploadHandler<span class="signature">(upload)</span><span class="type-signature"></span></h4>
    
    
</dt>
<dd>
    
    
    <div class="description">
        An <code>UploadHandler</code> is a <a href="global.html#Handler"><code>Handler</code></a> that accepts a
<a href="http.HttpServerFileUpload.html"><code>HttpServerFileUpload</code></a> 
object as it's parameter. This allows server code to handle and process
uploaded files from HTTP clients.
    </div>
    

    
    
    
    
    
        <h5>Parameters:</h5>
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		
		
		
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr>
            
                <td class="name"><code>upload</code></td>
            
            
            <td class="type">
            
                
<span class="param-type"><a href="http.HttpServerFileUpload.html">module:vertx/http.HttpServerFileUpload</a></span>


            
            </td>
            
            
            
            
            
            <td class="description last">The file being uploaded</td>
        </tr>
	
	
	</tbody>
</table>
    
    
    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="http.js.html">vertx/http.js</a>, <a href="http.js.html#line554">line 554</a>
    </li></ul></dd>
    
    
    
    
    
    
    
</dl>

    
    

    

    
    
    
    
    
    
    
</dd>

            
                
<dt>
    <h4 class="name" id="WebSocketHandler"><span class="type-signature"></span>WebSocketHandler<span class="signature">(websocket)</span><span class="type-signature"></span></h4>
    
    
</dt>
<dd>
    
    
    <div class="description">
        A <code>WebSocketHandler</code> is a <a href="global.html#Handler"><code>Handler</code></a> that accepts a
<a href="http.WebSocket.html"><code>WebSocket</code></a> as it's parameter.
    </div>
    

    
    
    
    
    
        <h5>Parameters:</h5>
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		
		
		
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr>
            
                <td class="name"><code>websocket</code></td>
            
            
            <td class="type">
            
                
<span class="param-type"><a href="http.WebSocket.html">module:vertx/http.WebSocket</a></span>


            
            </td>
            
            
            
            
            
            <td class="description last">the active <a href="http.WebSocket.html"><code>WebSocket</code></a></td>
        </tr>
	
	
	</tbody>
</table>
    
    
    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="http.js.html">vertx/http.js</a>, <a href="http.js.html#line1698">line 1698</a>
    </li></ul></dd>
    
    
    
    
    
    
    
</dl>

    
    

    

    
    
    
    
    
    
    
</dd>

            </dl>
    
    
    
</article>

</section>  




</div>

<nav>
    <h2><a href="index.html">Index</a></h2><h3>Modules</h3><ul><li><a href="module-vertx.html">vertx</a></li><li><a href="buffer.html">vertx/buffer</a></li><li><a href="console.html">vertx/console</a></li><li><a href="container.html">vertx/container</a></li><li><a href="event_bus.html">vertx/event_bus</a></li><li><a href="file_system.html">vertx/file_system</a></li><li><a href="http.html">vertx/http</a></li><li><a href="multi_map.html">vertx/multi_map</a></li><li><a href="net.html">vertx/net</a></li><li><a href="parse_tools.html">vertx/parse_tools</a></li><li><a href="pump.html">vertx/pump</a></li><li><a href="shared_data.html">vertx/shared_data</a></li><li><a href="sockjs.html">vertx/sockjs</a></li><li><a href="timer.html">vertx/timer</a></li></ul><h3>Externals</h3><ul><li><a href="InetSocketAddress.html">InetSocketAddress</a></li><li><a href="Buffer_.html">Buffer</a></li><li><a href="RecordParser.html">RecordParser</a></li><li><a href="SockJSSocket.html">SockJSSocket</a></li></ul><h3>Classes</h3><ul><li><a href="buffer-Buffer.html">Buffer</a></li><li><a href="file_system.AsyncFile.html">AsyncFile</a></li><li><a href="http.HttpClient.html">HttpClient</a></li><li><a href="http.HttpClientRequest.html">HttpClientRequest</a></li><li><a href="http.HttpClientResponse.html">HttpClientResponse</a></li><li><a href="http.HttpServer.html">HttpServer</a></li><li><a href="http.HttpServerFileUpload.html">HttpServerFileUpload</a></li><li><a href="http.HttpServerRequest.html">HttpServerRequest</a></li><li><a href="http.HttpServerResponse.html">HttpServerResponse</a></li><li><a href="http.RouteMatcher.html">RouteMatcher</a></li><li><a href="http.WebSocket.html">WebSocket</a></li><li><a href="multi_map-MultiMap.html">MultiMap</a></li><li><a href="net.NetClient.html">NetClient</a></li><li><a href="net.NetServer.html">NetServer</a></li><li><a href="net.NetSocket.html">NetSocket</a></li><li><a href="pump-Pump.html">Pump</a></li><li><a href="sockjs.SockJSServer.html">SockJSServer</a></li></ul><h3>Mixins</h3><ul><li><a href="ClientSSLSupport.html">ClientSSLSupport</a></li><li><a href="ReadStream.html">ReadStream</a></li><li><a href="ServerSSLSupport.html">ServerSSLSupport</a></li><li><a href="ServerTCPSupport.html">ServerTCPSupport</a></li><li><a href="SSLSupport.html">SSLSupport</a></li><li><a href="TCPSupport.html">TCPSupport</a></li><li><a href="WriteStream.html">WriteStream</a></li></ul><h3><a href="global.html">Global</a></h3>
</nav>

<br clear="both">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> on Wed Jul 17 2013 20:27:23 GMT+0100 (BST)
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>